Summary View

This Summary View widget requires "<my_cdn>"/summary-panel/ansummarypanel.js and "<my_cdn>"/summary-view/ansummaryview.js scripts file and use the <an-summary-view> Custom HTML Tag

Configuration Object

{
  domain: "https://your_qrvey_domain",
  api_key: "<API_KEY>",
  user_id: "<USER_ID>"
  app_id: "<APP_ID>",
  qrveyhash: "<QRVEY_HASH>",
  qrveyid: "<QRVEY_ID>",
}

### Properties and Values

Property	Value
domain	String, Qrvey Core URL.
api_key	String, Api Key. Identification code to connect to the data.
user_id	String, User identifier.
app_id	String, Identifier of the Qrvey application.
qrveyhash	String, Qrvey Hash.
qrveyid	String, Identifier of the Qrvey.

Other configuration properties

{
  "panelConfig": {
    "drillConfig": {
      "persist": <true | false>,
      "enabled": <true | false>
    },
    "filters": <true | false>
  }
}

Property	Value
panelConfig	Object. Configuration for the panel, receives some properties to change the appearance or behavior of the panels
panelConfig.drillConfig	Object. settings to use the Drill-down functionality that are used in the histogram charts
panelConfig.drillConfig.persist	Boolean. Condition to establish if they need the chosen Drill-down filters to persist over time.
panelConfig.drillConfig.enabled	Boolean. Condition to enable Drill-down functionality.
panelConfig.filters	Boolean. Activate or deactivate the filter button within the panels.

Event Listeners

• ON_CLOSE_BUCKET_MODAL

  Listener to refresh the Summary View component when the Buckets Modal is closed.

  event.detail object:

Property	Value	Required
hasChanges	Boolean, Condition to establish changes within Summary View as long as there were changes.	Yes

• triggerOpenBranch

  Listener to add, within the Summary View, the extra panels of branches.

  event.detail object:

Property	Value	Required
questionid	String, The identifier of the question related to the branches	Yes
questions	Array, Set of concatenated branches in the same level	Yes
branches	Array, Set of branches.	Yes

• triggerCloseBranch

  Listener to hide, within the Summary view, the extra panels of branches

  event.detail object:

Property	Value	Required
closeQuestion	Boolean, Condition to close the branches	Yes
questionid	String, The identifier of the question related to the branches	Yes
hasBranches	Boolean, property to concoer if there are branches or not.	Yes
element	HTMLAnSummaryHeaderElement, Html element of the header.	Yes
inBranch		No

Methods

• applyFilters

  Set incoming filters by parameter

Param	Description	Required
filters	Array, Set of filters.	Yes

• checkBranchOpen

  Check if the branch panels are showing from the questionId

Param	Description	Required
questionid	String, Identifier of the question.	Yes

      Returns: Boolean.

• downloadData

  Download the visible information within Summary View, depending on the type of file.

Param	Description	Required
type	String, The type of download. They can be csv, pdf, jpg.	Yes

  Returns <Promise | undefined> , If there are no questions to download it will return undefined, otherwise it will return a Promise with the data.

• reloadAllSummaryView

  Reload the Summary View again.

Example

<script src = "<WIDGET_SUMMARY_PANEL_LOADER_URL>"> </ script>
<script src = "<WIDGET_SUMMARY_VIEW_LOADER_URL>"> </ script>
 
<script>
  window.summaryConfig = {
    qrveyhash: '<QRVEYHASH>',
    domain: 'https://your_qrvey_domain',
    api_key: '<API_KEY>',
    qrveyid: "<QRVEY_ID>",
    app_id: "<APP_ID>",
    user_id: "<USER_ID>"
    panelConfig: {
      drillConfig: {
        persist: true,
        enabled: true
      },
      filters: true
    }
  }
</ script>
<an-summary-view config = "summaryConfig"> </ an-summary-view>